.. |High_ic1| image:: Img/High_ic1.png
.. |Low_ic1| image:: Img/Low_ic1.png
.. |Search_ic| image:: Img/Search_ic.png
.. |Del_ic1| image:: Img/Del_ic1.png
.. |Del_ic2| image:: Img/Del_ic2.png
.. |Star_ic| image:: Img/Star_ic.png
.. |Flag_ic| image:: Img/Flag_ic.png
.. |Add_ic| image:: Img/Add_ic.png
.. |rClear_ic| image:: Img/rClear.png
.. |rRecov_ic| image:: Img/rRecov.png
.. |Details_ic| image:: Img/Details_ic.png
.. |Local_ic| image:: Img/Local_ic.png
.. |Not-allowed_ic| image:: Img/Not-allowed_ic.png
.. |Del_ic8| image:: Img/Del_ic8.png
.. |Clear_ic1| image:: Img/Clear_ic1.png
.. |Recov_ic1| image:: Img/Recov_ic1.png
.. |Local_ic1| image:: Img/Local_ic1.png
.. |IRed_ic| image:: Img/IRed.png
.. |Otm_ic| image:: Img/Otm.png
.. |Shrift_ic| image:: Img/Shrift.png
.. |Str_ic| image:: Img/Str.png
.. |Spis_ic| image:: Img/Spis.png
.. |Zit_ic| image:: Img/Zit.png
.. |Inte_ic| image:: Img/Inte.png
.. |Wik_ic| image:: Img/Wik.png
.. |Iso_ic| image:: Img/Iso.png
.. |Tab_ic| image:: Img/Tab.png
.. |Lin_ic| image:: Img/Lin.png
.. |Ochis_ic| image:: Img/Ochis.png
.. |rKnop3_ic| image:: Img/rKnop_3.png
.. |rKnop1_ic| image:: Img/rKnop_1.png
.. |rKnop2_ic| image:: Img/rKnop_2.png
.. |rKnopPok_ic| image:: Img/rKnopPok.png
.. |rKnopNastr_ic| image:: Img/rKnopNastr.png
.. |rRich_ic| image:: Img/rRich.png
.. |rNKn_ic| image:: Img/rNKn.png
.. |fico_ic| image:: Img/fico.png
.. |sSpec_ic| image:: Img/sSpec.png
.. |sSled_ic| image:: Img/sSled.png
.. |sNaz_ic| image:: Img/sNaz.png
.. |sStre_ic| image:: Img/sStre.png
.. |sOSp_ic| image:: Img/sOSp.png
.. |fleJson_ic| image:: Img/FormLinkEditorJson.png
.. |fleAdd_ic| image:: Img/FormLinkEditorAddLink.png
.. _Руководство по настройке форм:
##############################
Руководство по настройке форм
##############################
**********************************************
Назначение редактора форм
**********************************************
Форма - это визуальное представление данных в виде полей для отображения и редактирования данных, а также для отображения связанных данных.
Форма позволяет пользователю взаимодействовать с приложением для выполнения автоматизируемой деятельности компании.
В функции Администратора Системы входит создание, изменение, копирование, удаление форм, настройка визуальных компонентов форма, а также настройка доступа к формам или к определенным полям форм для различных ролей пользователей.
**********************************************
Описание формы и ее компонентов
**********************************************
==================================================
Свойства формы
==================================================
Форма имеет следующие свойства:
*ID*
Рдентификатор формы. Значение формируется автоматически. Поле доступно для редактирования.
*ID Схемы*
РР· выпадающего СЃРїРёСЃРєР° нужно выбрать идентификатор схемы, данные РёР· которой Р±СѓРґСѓС‚ отображаться РЅР° форме
(подробнее о настройке схем см. :ref:`Руководство по настройке схем`).
*Название формы*
Текстовое поле для ввода названия формы.
*Карточка*
Рлемент интерфейса «Переключатель». Р’ зависимости РѕС‚ состояния (включен/выключен) показывает, используется или нет данная форма для отображения РІ РІРёРґРµ карточки РІ консоли
(подробнее о настройке консолей см. :ref:`Руководство по настройке консолей`).
*ID Сайдбара*
РР· выпадающего СЃРїРёСЃРєР° нужно выбрать идентификатор сайдбара, который будет отображаться РЅР° форме РІ качестве панели инструментов (тулбара)
(подробнее о настройке сайдбаров см. :ref:`Руководство по настройке сайдбаров`).
*Форма группы*
РР· выпадающего СЃРїРёСЃРєР° нужно выбрать РіСЂСѓРїРїСѓ, Рє которой принадлежит форма.
*Описание*
Текстовое поле для ввода описания формы.
*Дата изменения*
В поле автоматически устанавливаются дата и время последнего изменения формы в формате ДД.ММ.ГГГГ, ЧЧ:ММ:СС. Поле недоступно для редактирования.
*Роль*
РР· выпадающего СЃРїРёСЃРєР° нужно выбрать роль, которой будет доступна данная форма.
*РўРёРї*
Поле на данный момент не используется.
*РРєРѕРЅРєР°*
РР· выпадающего СЃРїРёСЃРєР° можно выбрать РёРєРѕРЅРєСѓ, которая будет отображаться РІ заголовке формы РЅР° ее странице.
Флаг *Рспользовать для результатов РїРѕРёСЃРєР°*.
При выставленном флаге форма будет использоваться при переходе со страницы поиска на выбранный результат в результате полнотекстового поиска.
Флаг *Рспользовать как форму РїРѕ-умолчанию*.
При выставленном флаге в этой форме по умолчанию открываются записи из консоли, если в консоли не указана другая форма, в которой нужно открывать записи.
*Компоненты*
Описываются компоненты формы. Для описания используется визуальный редактор на отдельной вкладке.
*Стили*
Описываются стили формы, которые позволяют изменить внешний вид формы.
*Действия*
Описываются действия, связанные с формой. Данные свойства описываются на вкладке **Действия** редактора форм.
*Параметры*
В свойстве **параметры** описываются вспомогательные свойства формы, которые могут иметь сложное описание. Данные свойства описываются на вкладке **Параметры** редактора форм.
*РЎРІСЏР·Рё*
Описываются свойства связи записи с другими записями. Данные свойства описываются на вкладке **Связи** редактора форм.
==================================================
Свойства компонента формы
==================================================
Компонент формы имеет следующие свойства:
*ID*
Рдентификатор компонента шаблона. Значение формируется автоматически. Поле доступно для редактирования.
*Название*
Текстовое поле для ввода названия компонента шаблона.
*РўРёРї*
РР· выпадающего СЃРїРёСЃРєР° нужно выбрать тип компонента. Подробнее Рѕ типах СЃРј. `Описание типов компонентов`_.
*Подтип*
РР· выпадающего СЃРїРёСЃРєР° нужно выбрать подтип компонента. Подробнее Рѕ подтипах СЃРј. `Описание типов компонентов`_.
*Видимый*
Рлемент интерфейса «Переключатель». Р’ зависимости РѕС‚ состояния (включен/выключен) показывает, РІРёРґРёРј компонент РЅР° форме или скрыт.
*Тип доступа*
РР· выпадающего СЃРїРёСЃРєР° нужно выбрать РѕРґРЅРѕ РёР· значений:
*По умолчанию*
Поле доступно для редактирования.
*Только чтение*
Поле доступно только для чтения, но с полем можно взаимодействовать (выделить, скопировать текст).
*Отключен*
Поле недоступно для редактирования. При этом
поле визуально затемнено, при наведении на него вид курсора меняется на |Not-allowed_ic|, с полем нельзя взаимодействовать (выделить, скопировать текст).
*По умолчанию*
Указывается значение, которое будет использовано при создании новой записи, если поле, соответствующее компоненту шаблона, пустое. При изменении существующей записи указанное значение не используется.
Если в поле «По умолчанию» ничего не указано, это значит, что при создании новой записи, поле, соответствующее компоненту шаблона, может быть пустым (не обязательным для заполнения).
*Схема*
РР· выпадающего СЃРїРёСЃРєР° нужно выбрать идентификатор поля схемы, РёР· которого Р±СѓРґСѓС‚ выводиться данные РІ данный компонент РЅР° форме.
*Вычисляемое*
В данном поле можно задать вычисляемое значение. Значение в этом поле вычисляется на основе значений других полей. Условие, по которому вычисляется значение, указывается в формате JSON.
*Действия*
В данном поле в формате JSON описываются действия, связанные с компонентом формы. Например, нажатие на кнопку.
*Видимый на*
В поле можно указать условие видимости для элемента. Условие применяется, только при включенном переключателе «Видимый». Условие указывается в формате JSON.
*Параметры*
| В свойстве **параметры** описываются вспомогательные свойства компонента, которые могут иметь сложное описание. Данные свойства описываются на вкладке **Параметры** редактора компонента.
| В этом поле можно указать конфигурации для внешних скриптов (зависимостей). Перечень конфигураций указывается в формате JSON.
| В зависимости от типа компонента набор параметров может отличаться.
*Стиль*
Описываются стили компонента формы, которые позволяют изменить внешний вид компонента формы.
*Данные*
| Описываются вспомогательные свойства компонента, связанные с обработкой данных.
| В зависимости от типа компонента набор параметров обработки данных может отличаться.
.. _Описание типов компонентов:
==================================================
Визуальные компоненты формы
==================================================
На форме могут поддерживаться следующие визуальные компоненты:
* :ref:`button <button>`
* :ref:`datetime <datetime>`
* :ref:`datetime picker <datetime picker>`
* :ref:`icon <icon>`
* :ref:`input <input>`
* :ref:`html outer <html outer>`
* :ref:`separator <separator>`
* :ref:`radio <radio>`
* :ref:`rich text <rich text>`
* :ref:`select <select>`
* :ref:`upload <upload>`
* :ref:`download <download>`
* :ref:`xml <xml>`
* :ref:`map <map>`
* :ref:`table <table>`
* :ref:`gauge <gauge>`
* :ref:`dictionary <dictionary>`
* :ref:`number <number>`
* :ref:`toggle <toggle>`
* :ref:`rating <rating>`
* :ref:`Группа компонентов (контейнер) <container>`
* `Компонент отображения связей`_
.. note:: с компонентами формы могут быть связаны действия, выполняемые пользователями при взаимодействии с компонентом.
.. _button:
--------------------------------------------------------
**Описание компонента «button»**
--------------------------------------------------------
Компоненту с типом «button» на форме соответствует кнопка, после нажатия на которую выполняется действие, указанное в поле «Действия» на вкладке «Свойства»
компонента.
Для компонента с типом «button» можно указать класс на вкладке «Стиль» формы создания/редактирования компонента (:numref:`7Pic32`).
При этом у кнопки на форме будут разные цвета в зависимости от значения в поле «Класс» вкладки «Стиль» компонента шаблона.
Для компонента с типом «button» планируется использовать соответствующий класс из UI фреймворка.
.. _datetime:
--------------------------------------------------------
**Описание компонента «datetime»**
--------------------------------------------------------
Компоненту с типом «datetime» соответствует поле с датой и временем в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС. Компонент доступен только для чтения.
.. _datetime picker:
--------------------------------------------------------
**Описание компонента «datetime-picker»**
--------------------------------------------------------
Компоненту с типом «datetime-picker» соответствует поле для ввода или выбора даты и времени из формы с календарем и часами.
Данные в этом поле отображаются в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.
.. _icon:
--------------------------------------------------------
**Описание компонента «icon»**
--------------------------------------------------------
Компоненту СЃ типом В«iconВ» соответствует РёРєРѕРЅРєР°. РРєРѕРЅРєСѓ необходимо выбрать РёР· выпадающего СЃРїРёСЃРєР° «Подтип» вкладки «Свойства».
Компоненту с типом «icon» на форме соответствует иконка, после нажатия на которую выполняется действие, указанное в поле «Действия» на вкладке «Свойства»
компонента.
.. _input:
--------------------------------------------------------
**Описание компонента «input»**
--------------------------------------------------------
Компоненту с типом «input» на форме соответствует текстовое поле для ввода. При сохранении формы данные, введенные в это текстовое поле, сохранятся в
поле схемы, идентификатор которого указан в поле «Схема» вкладки «Свойства».
У компонента с типом «input» может быть два подтипа:
*plain*
Соответствует простому однострочному полю ввода.
*textarea*
Позволяет ввести в поле несколько строк текста.
.. note:: Если у элемента с типом «input» подтип не выбран, то по умолчанию будет доступен только однострочный ввод.
.. _html outer:
--------------------------------------------------------
**Описание компонента «html-outer»**
--------------------------------------------------------
Компонент с типом «html-outer» предназначен для форматированного отображения текста на форме. Текст может быть в том числе и произвольный.
Для компонента доступны следующие подтипы:
* пустой - отображает стилизованное содержимое поля в режиме чтение
* enum - отображает локализованное значение enum поля в режиме **для чтения**
* html - отображает html содержимое поля
* ar_kb_article - устаревшее, отображал значение поля в формате xml ( decision tree)
.. _separator:
--------------------------------------------------------
**Описание компонента «separator»**
--------------------------------------------------------
Компонент с типом «separator» на форме переносит последующие компоненты на новую строку.
.. _radio:
--------------------------------------------------------
**Описание компонента «radio»**
--------------------------------------------------------
Компоненту с типом «radio» соответствует радиокнопка (переключатель).
На вкладке параметры может быть определен тип отображения радио кнопки: `{"type":"toggle"}`.
На вкладке **Данные** могут быть определены/настроены возможные значения.
.. _rich text:
--------------------------------------------------------
**Описание компонента «rich-text»**
--------------------------------------------------------
Rich-text поле используется в формах для обработки и хранения форматированного текста. При нажатии символа |rRich_ic| на компоненте rich-text (:numref:`7Pic35_1`) откроется редактор Markdown, в котором производится редактирование форматированного текста в формате Markdown (:numref:`7Pic35_2`).
.. _7Pic35_1:
.. figure:: Img/rRichKomp.png
:scale: 80 %
:align: center
*Открытие редактора Markdown*
.. _7Pic35_2:
.. figure:: Img/rRichMd.png
:scale: 80 %
:align: center
*Окно редактора Markdown*
Подробно работа с редактором Markdown описана в :ref:`Описание работы с полем markdown в форме`.
.. _Описание работы с полем markdown в форме:
--------------------------------------------------------
Описание работы с полем markdown в форме.
--------------------------------------------------------
Поле Markdown это поле типа rich-text. Rich-text поле используется в формах для обработки и хранения форматированного текста, например для описания запроса, в формате языка разметки Markdown. Markdown – облегченный язык разметки, созданный для написания, чтения, оформления веб-текстов.
Для создания описания в поле формы *Описание запроса* (:numref:`7Pic1ad`) следует нажать на символ |IRed_ic|, после чего откроется редактор Markdown (:numref:`7Pic2ad`).
.. _7Pic1ad:
.. figure:: Img/Zapr.png
:scale: 80 %
:align: center
*Поле Описание запроса*
.. _7Pic2ad:
.. figure:: Img/Redakt.png
:scale: 80 %
:align: center
*Редактор Markdown*
Далее следует ввести в редакторе Markdown описание запроса в формате языка разметки Markdown.
В редакторе существует следующая система управления:
Кнопки |Otm_ic| позволяют отменить последние действия.
Кнопка «Стиль заголовка» с всплывающим списком позволяет выбрать один из шести стилей заголовка (:numref:`7Pic3ad`).
.. _7Pic3ad:
.. figure:: Img/Stil.png
:scale: 80 %
:align: center
*Кнопка «Стиль заголовка»*
Кнопки |Shrift_ic| позволяют выбрать стиль шрифта.
Кнопка |Str_ic| позволяет вводить строчный код.
Кнопки |Spis_ic| позволяю вводить ненумерованный и нумерованный список.
Кнопка |Zit_ic| позволяет выделить текст как цитату.
Кнопка |Inte_ic| позволяет вставлять ссылки на страницы в интернете.
Кнопка |Wik_ic| позволяет добавлять wiki-ссылки. Адрес ссылки вставляется автоматом и берется либо из параметров формы, либо из глобальных настроек.
Кнопка |sSpec_ic| позволяет вставить в текст спецсимвол. Спецсимволы – это набор последовательностей, которые заменяют запрещенные для ввода с клавиатуры символы.
При нажатии на кнопку |sSpec_ic| открывается форма ввода спецсимволов (:numref:`7Pic19e`).
.. _7Pic19e:
.. figure:: Img/sTabsI.png
:scale: 80 %
:align: center
*Форма выбора спецсимвола*
Выбор спецсимвола производится левым кликом мыши по иконке спецсимвола, после чего он отобразится в поле **Выбран символ**. Вставка спецсимвола в текст происходит при нажатии кнопки **ОК** в правом нижнем углу формы. При нажатии кнопки **ОТМЕНА** в правом нижнем углу формы происходит закрытие формы без вставки символа (:numref:`7Pic19e`).
Навигация по листам с иконками спецсимволов производится с помощью кнопок |sSled_ic| и |sNaz_ic| (:numref:`7Pic19e`).
После выбора спецсимвола в поле **Чарт символа** отображается имя блока кодировки. Блок кодировки так же возможно выбрать с помощью стрелки |sStre_ic| в правой части поля **Чарт символа**. Кнопка |sOSp_ic| позволяет перейти из блока кодировки Halfwidth and Fullwidth Forms в блок кодировки Specials (:numref:`7Pic19e`).
Подробную информацию по спецсимволам можно получить по ссылке https://unicode-table.com/ru/.
Кнопка |Iso_ic| позволяет добавить файл рисунка.
Кнопка |Lin_ic| позволяет добавить горизонтальную линию.
Кнопка |Tab_ic| позволяет добавить таблицу.
Кнопка |Ochis_ic| в правом верхнем углу редактора позволяет очистить поле редактирования.
Подробную информацию о языке разметки Markdown можно получить по ссылкам:
https://www.markdownguide.org/extended-syntax/
https://texterra.ru/blog/ischerpyvayushchaya-shpargalka-po-sintaksisu-razmetki-markdown-na-zametku-avtoram-veb-razrabotchikam.html
.. _select:
--------------------------------------------------------
**Описание компонента «select»**
--------------------------------------------------------
Компоненту с типом «select» на форме соответствует выпадающий список. В зависимости от выбранного подтипа этого компонента выпадающий список будет отличаться.
.. note:: Для типа **В«selectВ»** РІ вкладке *Стиль* РІ поле "РРєРѕРЅРєР° РїРѕРёСЃРєР°" необходимо указать только либо РёРєРѕРЅРєРё Material Icons (https://fonts.google.com/icons?selected=Material+Icons), либо РёРєРѕРЅРєРё приложения (СЃ префиксом *sgate*).
У компонента с типом «select» могут быть следующие подтипы:
*enum*
| Соответствует простому выпадающему списку. Данные выводятся из поля схемы, идентификатор которого указан в поле «Схема» на вкладке «Свойства» компонента.
| Данные при этом отображаются уже локализованными.
*enum_json*
Для данного компонента нужно задать возможные значения на вкладке «Данные».
.. _7Pic38_1:
.. figure:: Img/form-comp-select-json.png
:scale: 80 %
:align: center
*Пример компонента с типом «select/enum_json»*
*tree_nested*
| Компоненту с данным подтипом типа «select» на форме соответствует древовидная структура выпадающих списков и полей.
| Данному компоненту соответствует описание иерархии через поля, определяющие диапазон идентификаторов для ветки **left_nested_key, right_nested_key**.
.. _7Pic38_2:
.. figure:: Img/form-comp-select-nested.png
:scale: 80 %
:align: center
*Пример компонента с типом «select/tree-nested»*
*tree_parent*
| Компоненту с данным подтипом типа «select» на форме соответствует древовидная структура выпадающих списков и полей.
| Данному компоненту соответствует описание иерархии через ключ родительского элемента.
.. _7Pic38_3:
.. figure:: Img/form-comp-select-parent.png
:scale: 80 %
:align: center
*Пример компонента с типом «select/tree-parent»*
*tree_path*
| Компоненту с данным подтипом типа «select» на форме соответствует древовидная структура выпадающих списков и полей.
| Данному компоненту соответствует описание иерархии через поле, содержащие перечень идентификаторов в ветке: **100:200**
.. _7Pic38_4:
.. figure:: Img/form-comp-select-path.png
:scale: 80 %
:align: center
*Пример компонента с типом «select/tree-path»*
*tree_row*
| Компоненту с данным подтипом типа «select» на форме соответствует древовидная структура выпадающих списков и полей.
| Данному компоненту соответствует ветка дерева, описанная как строка таблицы.
| У каждого выпадающего списка есть свое поле для поиска по значениям. Таким образом, поиск значений может выполняться по всем уровням (т.е.
| по всем полям из блока "fields" в конфигурации компонента с типом «select/tree_row»).
| Конфигурация для компонента с типом «select/tree_row» указывается на вкладке «Данные».
.. _7Pic38_5:
.. figure:: Img/form-comp-select-row.png
:scale: 80 %
:align: center
*Пример компонента с типом «select/tree-row»*
.. _upload:
Для поля типа **select** могут быть определены следующие параметры:
* showDefaultsOnOpen
* pallete
--------------------------------------------------------
**Описание компонента «upload»**
--------------------------------------------------------
Компонент с типом «upload» применяется для закачивания вложений на сайт (сервер) и для работы с этими вложениями (добавление/удаление/скачивание).
.. _download:
--------------------------------------------------------
**Описание компонента «download»**
--------------------------------------------------------
Компонент с типом «download» отображается на форме в виде вложений с возможностью скачивания (:numref:`7Pic39`).
.. _7Pic39:
.. figure:: Img/Download_examp.png
:scale: 80 %
:align: center
*Пример компонента с типом «download» на форме*
В поле «Параметры» на вкладке «Свойства» формы создания/редактирования компонента с типом «download» необходимо указать параметр «attachmentsSchema», значением
которого будет название схемы, содержащей вложения.
.. _xml:
--------------------------------------------------------
**Описание компонента «xml»**
--------------------------------------------------------
У компонента с типом «xml» на вкладке «Свойства» формы создания/редактирования компонента в поле «Схема» указывается идентификатор поля схемы, в котором
хранится текст в формате «xml» (:numref:`7Pic41`).
.. _7Pic41:
.. figure:: Img/Xml_ar-dtree.png
:scale: 80 %
:align: center
*Свойства компонента с типом «xml»*
.. _map:
--------------------------------------------------------
**Описание компонента «map»**
--------------------------------------------------------
| Компоненту с типом «map» на форме соответствует маркер (координаты), указанный на карте.
| Функционал получения и отрисовки маркеров на карте реализован через внешние скрипты. Для каждой формы можно задать свой функционал через такой внешний скрипт.
| Функционал может включать источник данных местоположений, реакцию на клик по маркеру на карте и т.п.
| Внешний скрипт с функционалом нужно указать на вкладке «Параметры».
Пример заполнения вкладки «Данные» для компонента с типом «map»: ::
{"dependencies":[{"src":"e10802b3-035b-3284-801b-e6d1f5b2695a","name":"MAP"}],"url":"https://core-renderer-tiles.maps.yandex.net/tiles?l=map&x={x}&y={y}&z={z}&scale=1&lang=ru_RU"}
..
РіРґРµ:
* src - индекс внешнего скрипта
* name - имя зависимости, для карт необходимо установить в **MAP**
* url - шаблон url загрузки тайлов картографического сервера.
В приложении поддерживаются следующие картографические сервисы:
* OpenStreetMap
* Yandex Map
пример url для OSM: `{"url":"https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png","zoom":4,"center":[10,-20]}`
пример url для Yandex: `{"url":"https://core-renderer-tiles.maps.yandex.net/tiles?l=map&x={x}&y={y}&z={z}&scale=1&lang=ru_RU}`
.. _table:
--------------------------------------------------------
**Описание компонента «table»**
--------------------------------------------------------
Компоненту с типом «table» на форме соответствует таблица с данными. Колонки таблицы должны быть перечислены на вкладке «Данные» в формате JSON (:numref:`7Pic45`).
.. _7Pic45:
.. figure:: Img/Type_table.png
:scale: 80 %
:align: center
*Пример перечисления колонок для компонента с типом «table»*
В поле «Параметры» на вкладке «Свойства» можно задать различный функционал для компонента с типом «table». Функционал задается через внешние скрипты (:numref:`7Pic46`).
.. _7Pic46:
.. figure:: Img/Type_table1.png
:scale: 80 %
:align: center
*Пример указания внешнего скрипта для компонента с типом «table»*
.. note::
Компонент поддерживает возможность обработки кликов. Правила обработки задаются в поле **Действия** компонента.
.. _gauge:
--------------------------------------------------------
**Описание компонента «gauge»**
--------------------------------------------------------
Компоненту с типом «gauge» на форме соответствует виджет, отображающий линейную шкалу уровня качества сервиса (доступность, время отклика,
пропускная способность).
Конфигурация для виджета задается в поле «Параметры» на вкладке «Свойства» компонента.
.. _7Pic46-1:
.. figure:: Img/form-comp-gauge.png
:scale: 80 %
:align: center
*Пример настройки параметров для компонента с типом «gauge»*
Конфигурация виджета имеет следующий формат: ::
{
"label": "schm011_8",
"begin_date": "93af6751-17e7-3cf5-b098-b0ce5fc15185",
"end_date": "4df3029d-de83-3b33-9015-a63cc187a682",
"warning_time": "15h",
"bar_width": 20,
"pallete": {
"normal": {
"bar_color": "#00E160"
},
"warning": {
"bar_color": "#E9A726"
},
"expired": {
"bar_color": "#FF003E"
}
}
}
Здесь указано следующее:
*label*
Рдентификатор локализации для отображения заголовка виджета. Если РЅРµ задан, заголовок РЅРµ отображается.
*begin_date, end_date*
Рдентификаторы компонентов формы, РІ которые загружены соответствующие даты (дата начала, дата окончания).
Виджет не отображается в следующих случаях: если даты не заданы, либо они не валидны, либо они "перепутаны местами" (дата начала после даты окончания).
*warning_time*
Время до окончания, после которого полоса виджета будет подсвечена "предупреждающим" цветом.
Формат свойства: <число><символ>, где "число" - количественное значение времени, "символ" - единица измерения времени,
которая может быть "d" (дни), "h" (часы), "m" (минуты). Например, 15h - 15 часов, 10d - 10 дней.
*bar_width*
Ширина (толщина) цветной полосы в пикселях. Минимальное значение - 10, если оно меньше 10, то установится значение по умолчанию (10).
*pallete*
Палитра для раскрашивания полос виджета. Здесь возможны три свойства "normal" - для актуальной задачи, "warning" - для задачи, приближающейся к окончанию,
"expired" - для просроченной задачи. На данный момент доступно только свойство «bar_color», обозначающее цвет полосы виджета.
.. _dictionary:
--------------------------------------------------------
**Описание компонента «dictionary»**
--------------------------------------------------------
В зависимости от подтипа компоненту с типом «dictionary» на форме соответствуют различные виджеты.
Компонент с типом «dictionary» имеет следующие подтипы:
*subform*
Отображается виде подчиненной формы с полями для ввода (зависимой формы, расположенной на основной форме) (:numref:`7Pic47`).
.. _7Pic47:
.. figure:: Img/Type_dictionary_subform_input.png
:scale: 80 %
:align: center
*Пример отображения компонентов с типами «dictionary/subform» и «dictionary/input» на форме*
Для компонента с подтипом «subform» используется другая существующая форма. При настройке компонента указывается идентификатор зависимой формы
Рё РѕРЅР° отображается внутри текущей. Рспользуется РїРѕ умолчанию, если подтип РЅРµ задан.
*input*
Отображается в виде подчиненной формы с полями для ввода, которая открывается после нажатия на кнопку |Details_ic| «Подробнее» (:numref:`7Pic47`).
Для компонента с подтипом «input» используется другая существующая форма. При настройке компонента указывается идентификатор зависимой формы
и она открывается после нажатия на кнопку |Details_ic| «Подробнее» (:numref:`7Pic48`).
.. _7Pic48:
.. figure:: Img/Type_dictionary_input.png
:scale: 80 %
:align: center
*Пример зависимой формы для компонента с типом «dictionary/input»*
.. _7Pic48-1:
.. figure:: Img/form-comp-dictionary.png
:scale: 80 %
:align: center
*Пример настройки параметров для компонента с типом «dictionary»*
Конфигурация для виджетов задается в поле «Параметры» на вкладке «Свойства» компонента.
Пример конфигурации виджета в свойстве "Параметры" настройки компонента формы: ::
{
"form_id": "a305af33-3ac3-3fe5-be3d-0e57c40de5a6",
"search": {
"type": "select",
"fields": [],
"display_fields": ["company"],
"display_string": "{{ company }}",
"clause": {
"clauses": [
{
"field": "status",
"operand": "eq",
"value": "1"
},
{
"field": "company_type",
"operand": "contains",
"value": "Operating Company",
"clauses": [
{
"operator": "or",
"field": "company_type",
"operand": "contains",
"value": "Service Provider"
},
{
"operator": "or",
"field": "company_type",
"operand": "contains",
"value": "Customer"
}
]
}
]
}
}
}
Параметры конфигурации:
*form_id*
Рдентификатор существующей формы, которая будет использована РІ качестве подчиненной формы компонента.
Если параметр не задан, то данные виджета не будут отображены и Система выведет соответствующее предупреждение.
*search*
Параметры поиска данных в виджете. Является объектом, который содержит следующие свойства:
*type*
Тип виджета для поиска. Может принимать значения «select» или «tree»,
что соответствует либо выбору из простого одноуровневого списка, либо выбору из дерева значений.
Если свойство не задано, то по умолчанию будет использоваться виджет «select».
*fields*
Массив, который используется в виджете поиска «tree». Содержит поля схемы для построения дерева.
Массив **не должен** включать конечное поле, из которого будет выбрано значение.
Конечное поле **должно быть указано** в свойстве «display_fields».
*display_fields*
Поля схемы подчиненной формы, которые будут запрашиваться из схемы при обновлении данных.
По этим же полям будет осуществляться текстовый поиск в виджетах поиска.
*display_string*
Строка, которая будет отображаться в компоненте. Представляет собой шаблон для трансформации библиотекой «ST.js».
Если свойство не задано, то будет выводится идентификатор записи (т.е. шаблон будет выглядеть как {{ id }}).
*clause*
Дополнительные условия для выбора данных в виджетах поиска.
*Доступ к данным подчиненной формы*
Данные подчиненной формы хранятся в сторе «form» в свойстве «subformValues». Свойство представляет собой объект, у которого ключи -
это идентификатор компонента «dictionary» основной формы, а значение - это объект, у которого ключи, в свою очередь, являются идентификаторами компонентов
подчиненной формы, а значением - данные.
Пример свойства «subformValues»: ::
{
"3e5dde07-bf79-3197-8104-76004e0955c1": {
"96b88516-0f44-3950-9c78-060afd8bcca8": "Bob Baxter",
"f72dca3a-eb79-3627-af01-56f41babbbd2": "Calbro Services",
"7d3f202f-ad95-3901-b63f-07fa19016d79": "1 212 555-5454 (22)",
"d28b3b09-6989-3c5a-8dd1-723244082aef": "B.Baxter@calbroservices.com",
"de6553e5-3f2a-3bad-8d41-e36d3f47cfa6": "Information Technology"
},
"f498a3f4-f516-364c-92e5-b4d14f697803": {
"f5144ab6-e467-3fbe-bdec-a4a075577583": "Calbro Services"
},
"c8a96ece-d206-3c88-bdc2-6413e5957f63": {
"96b88516-0f44-3950-9c78-060afd8bcca8": "Андрей Андреев",
"f72dca3a-eb79-3627-af01-56f41babbbd2": "РљРѕСЃРјРѕСЃ",
"7d3f202f-ad95-3901-b63f-07fa19016d79": "###",
"d28b3b09-6989-3c5a-8dd1-723244082aef": "",
"de6553e5-3f2a-3bad-8d41-e36d3f47cfa6": "РћРћРћ \"РљРѕСЃРјРѕСЃ\""
}
}
В модуле «form» стора есть геттер «getSubformValues» для получения объекта со значениями по идентификатору компонента «dictionary»: ::
const subformValues = this.$store.getters['form/getSubformValues']('3e5dde07-bf79-3197-8104-76004e0955c1')
.. _number:
--------------------------------------------------------
**Описание компонента «number»**
--------------------------------------------------------
Тип компонента «number» - это числовое поле ввода (:numref:`7Pic48_1`).
.. _7Pic48_1:
.. figure:: Img/rNumb.png
:scale: 80 %
:align: center
*Пример компонента «number»*
Кнопка |rNKn_ic| позволяет уменьшить/увеличить значение поля. Так же возможно ручное редактирование.
Поле содержит подтипы int, float, что позволяет ввести в форму целочисленные данные или данные с плавающей точкой (:numref:`7Pic48_2`).
.. _7Pic48_2:
.. figure:: Img/rNPod.png
:scale: 80 %
:align: center
*Выбор подтипа компонента «number»*
Опции компонента задаются в свойстве «Параметры» компонента формы.
.. _toggle:
--------------------------------------------------------
**Описание компонента «toggle»**
--------------------------------------------------------
Тип компонента «toggle» - это переключатель (:numref:`7Pic48_3`), с подтипами checkbox и toggle.
.. _7Pic48_3:
.. figure:: Img/rTog.png
:scale: 80 %
:align: center
*Пример компонента «toggle» с подтипом «checkbox»*
Поле содержит подтипы checkbox и toggle (:numref:`7Pic48_3`) и (:numref:`7Pic48_4`).
.. _7Pic48_4:
.. figure:: Img/rTogtog.png
:scale: 80 %
:align: center
*Пример компонента «toggle» с подтипом «toggle»*
Опции компонента задаются в свойстве «Параметры» компонента формы.
.. _rating:
--------------------------------------------------------
**Описание компонента «rating»**
--------------------------------------------------------
Тип компонента «rating» позволяет отобразить рейтинг того или иного события (:numref:`7Pic48_5`).
.. _7Pic48_5:
.. figure:: Img/rRat.png
:scale: 80 %
:align: center
*Пример компонента «rating»*
Опции компонента задаются в свойстве «Параметры» компонента формы:
.. _7Pic48_6:
.. figure:: Img/form-comp-rating.png
:scale: 80 %
:align: center
*Пример параметров компонента «rating»*
.. _container:
--------------------------------------------------------
**Группа компонентов (контейнер)**
--------------------------------------------------------
| Формы поддерживают контейнеризацию (группирование компонентов).
| Отдельная группа компонентов, может поддерживать параметр **collapsed**, позволяющий переключать видимость группы ("схлопывать") компонентов формы при клике на заголовок группы.
.. _Компонент отображения связей:
--------------------------------------------------------
**Компонент отображения связей**
--------------------------------------------------------
Компонент отображения связей позволяет на форме представлять связи с другими записями. Например: связь инцидентов с конфигурационными инцидентами, связи с комментариями по ходу выполнения работ итп.
Положение компонента и способы взаимодействия с компонентом настраиваются в форме.
**********************************************
Общий функционал настройки форм
**********************************************
==================================================
Расположение редактора форм
==================================================
Страница настройки форм открывается по кнопке «Редактор форм» пункта «Администрирование» в сайдбаре Системы (:numref:`7Pic1`).
.. _7Pic1:
.. figure:: Img/Form_sidebar.png
:scale: 80 %
:align: center
*Кнопка «Редактор форм» в сайдбаре*
.. note:: Название пунктов меню сайдбара и расположение этих пунктов требуется уточнить в документации на Систему, так как они могут отличаться в зависимости от настроек Системы.
Страница настройки форм также открывается из интернет-браузера по адресу: <IP-адрес серверной части Системы>/admin/forms.
После нажатия на кнопку «Редактор форм» либо после перехода по адресу, указанному выше, в рабочей области Системы отобразится панель управления формами, таблица со списком существующих в Системе форм
и блок навигации по списку форм (:numref:`7Pic2`).
.. _7Pic2:
.. figure:: Img/rForm.png
:scale: 80 %
:align: center
*Редактор форм*
==================================================
Навигация и поиск
==================================================
--------------------------------------------------------
Навигация по таблице со списком форм
--------------------------------------------------------
Блок навигации по списку форм расположен под этим списком (:numref:`7Pic2`). В блоке навигации (:numref:`7Pic3`):
* Предусмотрена возможность выбирать из выпадающего списка количество записей, выводимых на лист. Выбрать можно одно из значений: 5, 7, 10, 15, 20, 25, 50, Все.
* Можно переходить на любую страницу таблицы по кнопкам |rKnop3_ic|.
* Можно переходить на в начало или конец списка по кнопкам |rKnop1_ic| и |rKnop2_ic|.
* Указывается диапазон записей на текущей странице и общее количество записей в таблице.
.. _7Pic3:
.. figure:: Img/rNav.png
:scale: 80 %
:align: center
*Блок навигации*
--------------------------------------------------------
Поиск и сортировка в колонке таблицы
--------------------------------------------------------
В шапке таблицы для каждой колонки предусмотрена возможность поиска данных и возрастающей/убывающей сортировки данных (:numref:`7Pic2`).
После нажатия на кнопку |Search_ic| «Поиск» в шапке таблицы появляется текстовое поле для ввода необходимого текста для поиска (:numref:`7Pic4`).
.. _7Pic4:
.. figure:: Img/Search2.png
:scale: 80 %
:align: center
*Поле для поиска*
При вводе в это поле определенной комбинации знаков в таблице остаются только те записи,
у значений которых в данной колонке присутствует введенная комбинация знаков (:numref:`7Pic5`).
.. _7Pic5:
.. figure:: Img/Search3.png
:scale: 80 %
:align: center
*Пример поиска в колонке таблицы*
Название фильтруемой колонки и значение, введенное в поле поиска, появятся над таблицей со списком форм (:numref:`7Pic6`).
.. _7Pic6:
.. figure:: Img/rID.png
:scale: 80 %
:align: center
*Значения для поиска в колонках*
Таким же образом над таблицей отображаются названия всех фильтруемых колонок и значения, введенные в соответствующие поля поиска (:numref:`7Pic6`).
Если для колонки заполнено поле поиска, то кнопка «Поиск» подсвечивается цветом, задаваемым в настройках бренда(:numref:`7Pic6`).
Поле поиска очищается по кнопке |Del_ic1| (:numref:`7Pic5`) рядом с соответствующим значением, расположенным над таблицей (:numref:`7Pic6`).
Возрастающая сортировка в колонке выполняется по кнопке |Low_ic1| (:numref:`7Pic7`), убывающая сортировка - по кнопке |High_ic1| (:numref:`7Pic8`).
.. _7Pic7:
.. figure:: Img/Sort_high.png
:scale: 80 %
:align: center
*Пример возрастающей сортировки*
.. _7Pic8:
.. figure:: Img/Sort_low.png
:scale: 80 %
:align: center
*Пример убывающей сортировки*
----------------------------------------------------------
Навигация между формой и редактором форм
----------------------------------------------------------
Редактор формы и форма поддерживают возможность навигации между формой и редактором форм.
Администратор системы имеет возможность перейти от формы к редактору и обратно.
Данная возможность настраивается в редакторе сайдбаров (необходимо настроить сайдбар формы)
Для перехода из формы в редактор необходимо нажать кнопку *Редактировать форму* в тулбаре формы:(:numref:`7Pic13_2`):
.. _7Pic13_2:
.. figure:: Img/FormToEditor.png
:scale: 80 %
:align: center
*Переход к редактору формы*
Для перехода из редактора формы в форму (редактирование записи) необходимо нажать кнопку *Новая запись формы* на толбаре редактора форм:(:numref:`7Pic13_3`):
.. _7Pic13_3:
.. figure:: Img/FormEditorToForm.png
:scale: 80 %
:align: center
*Переход к форме из редактора*
При настройке параметра noteId в редакторе сайдбаров при переходе из редактора сайдбаров можно вернуться r редактируемой ранее записи: (:numref:`7Pic13_4`)
.. _7Pic13_4:
.. figure:: Img/FormEditorToForm2.png
:scale: 80 %
:align: center
*Переход к форме из редактора для редактирования записи*
Пример настроек сайдбара приведен ниже: (:numref:`7Pic13_5`)
.. _7Pic13_5:
.. figure:: Img/FormToFormEditorTune.png
:scale: 80 %
:align: center
*Пример настроек сайдбара*
==================================================
Доступность кнопок на панели управления
==================================================
Кнопки «Обновить список форм» и «Создать форму» на панели управления формами доступны всегда.
Кнопки «Редактировать форму», «Копировать форму» ,«Удалить форму» на панели управления формами доступны,
если у одной записи таблицы включен флаг в первой колонке (:numref:`7Pic2`). Если запись не выбрана, то эти кнопки недоступны (:numref:`7Pic9`).
.. _7Pic9:
.. figure:: Img/rPois.png
:scale: 80 %
:align: center
*Недоступные кнопки*
Кнопки «Редактировать форму», «Копировать форму» недоступны, если у нескольких записей таблицы включен флаг в первой колонке (:numref:`7Pic10`).
В этом случае на панели управления формами остаются доступными только кнопки для массовых операций, кнопка «Обновить список форм» и кнопка «Создать форму»
(см. `Массовые операции над записями таблицы`_).
==================================================
Создание формы
==================================================
Создание формы выполняется по кнопке «Создать форму» на панели управления формами (:numref:`7Pic12`).
.. _7Pic12:
.. figure:: Img/Create_but1.png
:scale: 80 %
:align: center
*Кнопка «Создать форму»*
По это кнопке открывается форма создания, имеющая следующие вкладки (:numref:`7Pic13`):
* Свойства.
* Компоненты.
* Стили.
* Действия.
* Параметры.
* РЎРІСЏР·Рё.
=======================================================
Редактирование формы
=======================================================
Редактирование формы выполняется по кнопке «Редактировать форму» на панели управления формами (:numref:`7Pic56`).
.. _7Pic56:
.. figure:: Img/rRF.png
:scale: 80 %
:align: center
*Кнопка «Редактировать форму»*
Функционал редактирования формы аналогичен функционалу создания формы.
=======================================================
Копирование формы
=======================================================
В случае, когда нужно создать форму, похожую на существующую, удобно воспользоваться функцией копирования формы.
Для копирования существующей формы необходимо выделить эту форму в списке форм и нажать кнопку «Копировать форму» на панели управления формами (:numref:`7Pic57`).
.. _7Pic57:
.. figure:: Img/rCF.png
:scale: 80 %
:align: center
*Кнопка «Копировать форму»*
После нажатия на эту кнопку откроется форма с данными скопированной формы. В ней нужно произвести необходимые изменения
и нажать кнопку «Сохранить форму» (:numref:`7Pic58`).
.. _7Pic58:
.. figure:: Img/rCF.png
:scale: 80 %
:align: center
*Скопированная форма*
После этого новая форма появится в списке форм (:numref:`7Pic59`).
.. _7Pic59:
.. figure:: Img/rSFTest.png
:scale: 80 %
:align: center
*Новая форма в списке форм*
=======================================================
Удаление формы
=======================================================
Удаление выбранной формы выполняется по кнопке «Удалить форму» на панели управления формами (:numref:`7Pic60`).
.. _7Pic60:
.. figure:: Img/rUF.png
:scale: 80 %
:align: center
*Кнопка «Удалить форму»*
В появившейся форме нужно подтвердить удаление по кнопке «Подтверждаю» (:numref:`7Pic61`).
.. _7Pic61:
.. figure:: Img/Confirm_del2.png
:scale: 80 %
:align: center
*Подтверждение удаления выбранной формы*
После этого форма будет удалена из списка форм.
=======================================================
Сохранение формы
=======================================================
Для сохранения формы необходимо нажать на кнопку "Сохранить" в верхнем правом углу редактора.
.. _7Pic13:
.. figure:: Img/New_form1.png
:scale: 80 %
:align: center
*Сохранение формы*
==================================================
Массовые операции над записями таблицы
==================================================
Массовые операции выполняются над записями, у которых включен флаг в первой колонке таблицы (:numref:`7Pic10`).
.. _7Pic10:
.. figure:: Img/rKnop.png
:scale: 80 %
:align: center
*Доступность кнопок при выборе нескольких записей*
Для выполнения массовых операций необходимо выбрать несколько записей в таблице.
Под таблицей указано количество выбранных записей (:numref:`7Pic10`).
.. note:: Включить/отключить флаг для всех записей на странице можно включением/отключением флага |Flag_ic| в шапке таблицы.
При выборе нескольких записей таблицы на панели управления формами доступными останутся только кнопки для выполнения массовых операций (:numref:`7Pic10`).
**Массовая операция удаления записей таблицы**
В Системе предусмотрено выполнение массовой операции удаления записей таблицы.
Для этого необходимо выбрать несколько записей и нажать кнопку «Удалить форму» (:numref:`7Pic10`).
После нажатия на эту кнопку откроется форма для подтверждения удаления выбранных форм (:numref:`7Pic11`).
.. _7Pic11:
.. figure:: Img/Confirm_del2.png
:scale: 80 %
:align: center
*Подтверждение удаления выбранных форм*
После нажатия на кнопку «Подтверждаю» выбранные формы будут удалены из списка форм.
**********************************************
Описание операций на вкладках редактора форм
**********************************************
==================================================
Вкладка «Свойства»
==================================================
На вкладке «Свойства» расположены следующие поля (:numref:`7Pic14`):
.. _7Pic14:
.. figure:: Img/New_form2.png
:scale: 80 %
:align: center
*Вкладка «Свойства»*
.. note:: Для корректного отображения формы в Ленте новостей следует в выпадающем списке "Форма группы" выбирать значение "feed_card".
Для добавления в выпадающий список "Форма группы" нового значения нужно очистить поле "Форма группы" по кнопке "Удалить" |Del_ic8|. Затем необходимо ввести новое значение в
это поле и нажать Enter. После этого новое значение появится в выпадающем списке "Форма группы" (:numref:`7Pic15`).
.. _7Pic15:
.. figure:: Img/Group.png
:scale: 80 %
:align: center
*Добавление новой группы*
.. note:: Все значения выпадающего списка "Форма группы", добавленные вручную, будут доступны в списке при переходе между формами в Редакторе форм до перезагрузки страницы.
После перезагрузки страницы все значения, добавленные вручную, исчезнут из выпадающего списка "Форма группы".
Для добавления в выпадающий список "Роль" нового значения нужно очистить поле "Роль" по кнопке "Удалить" |Del_ic8|. Затем необходимо ввести новое значение в
это поле и нажать Enter. После этого новое значение появится в выпадающем списке "Роль" (:numref:`7Pic16`).
.. _7Pic16:
.. figure:: Img/New_role.png
:scale: 80 %
:align: center
*Добавление новой роли*
.. note:: Все значения выпадающего списка "Роль", добавленные вручную, будут доступны в списке при переходе между формами в Редакторе форм до перезагрузки страницы.
После перезагрузки страницы все значения, добавленные вручную, исчезнут из выпадающего списка "Роль".
==================================================
Вкладка «Компоненты»
==================================================
--------------------------------------------------------
Общий функционал
--------------------------------------------------------
На вкладке «Компоненты» создается шаблон формы: наполнение формы компонентами и привязка данных схемы к этим компонентам.
На вкладке «Компоненты» расположены:
* Панель управления шаблоном формы (:numref:`7Pic18`).
* Блок, содержащий:
* перечень компонентов интерфейса, которые можно вывести на форму (:numref:`7Pic18`),
* список полей схемы, данные из которых будут выводиться на форму (:numref:`7Pic17`).
.. _7Pic17:
.. figure:: Img/Schema_fields.png
:scale: 80 %
:align: center
*Список полей выбранной схемы*
* Рабочая область для создания шаблона формы (:numref:`7Pic18`).
.. _7Pic18:
.. figure:: Img/rFormesozd.png
:scale: 80 %
:align: center
*Вкладка «Компоненты»*
**Работа с элементами панели управления шаблоном**
Панель управления шаблоном формы содержит следующие элементы (:numref:`7Pic18`):
Переключатели:
*Режим редактирования*
Позволяет включить/отключить режим редактирования формы. При выключенном переключателе вывод на форму компонентов интерфейса невозможен.
*Скрытые элементы*
Скрывает/отображает скрытые компоненты шаблона (см. `Настройка компонентов шаблона`_).
*Границы элементов*
Показывает/скрывает границы компонентов интерфейса на форме.
*Компактный режим*
Переключает компактное и развернутое расположение компонентов интерфейса.
РљРЅРѕРїРєРё:
*Кнопка «Очистить шаблон формы»*
По кнопке |rClear_ic| «Очистить шаблон формы» рабочая область для создания шаблона полностью очищается.
*Кнопка «Восстановить шаблон»*
По кнопке |Recov_ic1| «Восстановить шаблон» шаблон формы восстанавливается из файла бэкапа.
*Кнопка «Показать шаблоны»*
По кнопке |rKnopPok_ic| «Показать шаблоны» скрывается/отображается развернутая и компактная форма шаблона.
*Кнопка «Показать настройки»*
По кнопке |rKnopNastr_ic| скрываются/отображаются настройки шаблона.
*Поле поиска компонентов шаблона*
Поиск выполняется по значениям идентификаторов компонентов шаблона.
При вводе в поле поиска определенной комбинации знаков компоненты, в значениях идентификаторов или наименований которых присутствует введенная комбинация знаков,
выделяются рамкой (:numref:`7Pic19`).
.. _7Pic19:
.. figure:: Img/rPoisk.png
:scale: 80 %
:align: center
*Пример поиска компонентов шаблона*
**Наполнение шаблона компонентами. Работа с группами компонентов.**
Наполнение шаблона формы компонентами выполняется перетаскиванием их из блока компонентов в рабочую область создания шаблона (:numref:`7Pic20`). Поля можно перетаскивать за специальный значок с 6 точками |fico_ic|, контейнер - за любое место в пределах контейнера, кроме этого же значка.
.. _7Pic20:
.. figure:: Img/Drag_and_drop.png
:scale: 80 %
:align: center
*Перетаскивание компонентов в шаблон формы*
Редактор компонентов открывается из контекстного меню по клику правой кнопкой мыши на нужном компоненте. Редактор контейнера - из меню по правой кнопке на пустой части контейнера или из подменю дочернего компонента.
Компоненты размещаются в шаблоне внутри автоматически создаваемых групп (контейнеров). Контейнеры позволяют визуально сгруппировать поля на форме.
Количество компонентов в группе не ограничено. Компоненту в группе через всплывающее меню, появляющееся при нажатии правой кнопки мыши (:numref:`7Pic20_1`), можно задать следующие свойства (подробнее см. `Настройка компонентов шаблона`_):
.. _7Pic20_1:
.. figure:: Img/rKomp.png
:scale: 80 %
:align: center
*Всплывающее меню Свойства компонента*
В меню «Свойства компонента» используются следующие элементы управления:
* Первая строка меню - наименование компонента.
* Вторая строка меню - тип компонента.
* «Редактировать» - отрывает форму редактирования компонента.
* «Клонировать» - копирует компонент в буфер обмена.
* «Удалить» - удаляет компонент.
* «Переключить видимость» - используется для скрытия/отображения видимости компонента группы.
* «Расширить/сжать» - позволят переключиться между расширенным и сжатым расположением компонента в группе.
* Последняя строка - левый клик мыши открывает меню «Свойства группы» (:numref:`7Pic20_2`).
.. _7Pic20_2:
.. figure:: Img/rForme.png
:scale: 80 %
:align: center
*Всплывающее меню Свойства группы*
В меню «Свойства группы» применены следующие элементы управления:
* Первая строка меню - наименование группы.
* Вторая строка меню - тип группы.
* «Редактировать» - отрывает форму редактирования группы.
* «Клонировать» - копирует группу в буфер обмена.
* «Удалить» - удаляет группу.
* «Переключить видимость» - используется для скрытия/отображения видимости компонентов группы.
* «Видимость лейбла» - отображает/скрывает идентификатор группы.
* «Переключить подтип `collapsed`» - для того, чтобы группа была свернута при открытии формы, необходимо
параметру «collapsed» присвоить значение «true». Для того, чтобы группа была развернута при открытии формы, необходимо параметру «collapsed» присвоить значение «false».
* **Группу на форме можно скрыть вместе со всеми ее компонентами**. Для этого на вкладке «Свойства» формы создания/редактирования
компонента шаблона (в данном случае группы) переключатель «Видимый» должен быть выключен.
==================================================
Вкладка «Стили»
==================================================
На данной вкладке в поле «Styles» можно указать произвольный CSS (каскадная таблица стилей) для формы (:numref:`7Pic49`), которые могут быть использованы для стилизации компонентов формы.
.. _7Pic49:
.. figure:: Img/New_form4.png
:scale: 80 %
:align: center
*Вкладка «Стили»*
==================================================
Вкладка «Действия»
==================================================
На данной вкладке поле «Действия» планируется использовать для описания сценариев действия на стороне UI.
.. _7Pic50:
.. figure:: Img/New_form5.png
:scale: 80 %
:align: center
*Вкладка «Действия»*
==================================================
Вкладка «Параметры»
==================================================
На вкладке параметры из списка **Новый параметр** можно определить следующие вспомогательные свойства:
* title - формирование заголовка формы СЃ помощью данных текущей записи. (Рспользуется механизм st трансформаций)
* relations - место расположения связанных данных
* layoutmenu - внешний вид меню формы
* template - определяет параметры шаблонов данных, связанных с формой
* article_mapping - устаревший параметр
* dtree_remedy_schema - устаревший параметр
Для настройки внешнего вида меню необходимо выбрать внешний вид из списка:
* Линейный - все элементы меню располагаются в ряд над формой
* Правая панель - элементы меню располагаются в выпадающем вертикальном меню справа
* Левая панель - элементы меню располагаются в выпадающем вертикальном меню слева
* Верхнее меню - элементы меню отображаются в соответсвии с группировкой мню в сайдбаре
Для настройки параметров шаблонов необходимо указано следующее:
*Шаблон (template)*
Дефолтная схема шаблона.
*ID шаблона (templateid)*
Дефолтный идентификатор шаблона.
*Компонент шаблона (template_component)*
Рдентификатор компонента формы, значение которого используется как схема шаблона (необязательное).
*ID компонента шаблона (id_component)*
Рдентификатор компонента формы, значение которого используется как идентификатор шаблона (необязательное).
Вкладка «Параметры» также может использоваться для настройки форм для базы знаний:
Пример настройки форм для базы знаний: ::
{
"article_mapping": {
"%Remedy schema name%": {
"schema": "%SGate schema name%",
"fields": {
"%Remedy field ID%": "%SGate schema field name%",
...
}
},
...
}
}
{
"article_mapping": {
"RKM:KnownErrorTemplate": {
"schema": "known_error_template",
"fields": {
"302290901": "rkmtemplateattachmnt2_1",
"302291001": "rkmtemplateattachmnt2_2",
...
}
},
Здесь указано следующее:
*%Remedy schema name%*
Название формы в Remedy.
*%SGate schema name%*
Схема в SGate.
*%Remedy field ID%*
Рдентификатор поля РІ Remedy.
*%SGate schema field name%*
РРјСЏ поля схемы РІ SGate.
*fields*
Маппинг полей Remedy на поля SGate.
=============================================
Вкладка «Связи»
=============================================
--------------------------------------------------------
Общее описание
--------------------------------------------------------
| Вкладка "Связи" редактора форм позволяет описывать конфигурацию отображения связанных записей (записей других форм/схем данных) на форме.
| Связанные записи на форме могут отображаться в виде карточек или в виде таблицы.
| На форме может быть настроено множество связей с другими формами.
| Положение связанных записей определяется параметрами формы.
| Рнструменты вкладки являются редактором связей.
| Редактор связи состоит из компонента добавления новой связи и редакторов конфигураций отдельных связей.
--------------------------------------------------------
Поддерживаемые типы связей
--------------------------------------------------------
В системе поддерживаются следующие типы связей
.. list-table:: Описание типов связей
:widths: 80 80
:header-rows: 1
* - РўРёРї СЃРІСЏР·Рё
- Описание
* - Прямая простая связь
- | Позволяет описывать связь между схемами данных
| по ключу (аттрибут одной схемы совпадает
| с аттрибутом другой схемы).
| Поддерживаются связи типа 1:m или m:1
* - Табличная простая связь
- Позволяет описывать связи типа m:n между двумя схемами
* - Табличная сложная связь
- | Позволяет описывать связи типа m:n между
| схемой формы и множеством других схем.
--------------------------------------------------------
Настройка положения связанных записей на форме
--------------------------------------------------------
| Расположение связанных записей задается в поле *"Расположение связанных данных"* вкладки **Параметры** редактора форм.
| Способ расположения выбирается из списка доступных расположений.
--------------------------------------------------------
Добавление новой связи
--------------------------------------------------------
| Компонент добавления новой связи расположен вверху вкладки **Связи**.
| Для добавления новой связи необходимо определить тип (:numref:`7Pic50_1`), на следующем шаге подтип связи (:numref:`7Pic50_2`) и нажать на кнопку |fleAdd_ic|.
.. _7Pic50_1:
.. figure:: Img/FormEditorLinkAddPic1.png
:scale: 80 %
:align: center
*Добавление новой связи. Шаг 1*
.. _7Pic50_2:
.. figure:: Img/FormEditorLinkAddPic.png
:scale: 80 %
:align: center
*Добавление новой связи. Шаг 2*
После нажатия в редакторе становится доступным редактор новой связи, в котором можно настроить параметры связи, в зависимости от выбранного типа связи.
--------------------------------------------------------
Общие настройки связей
--------------------------------------------------------
В общий настройках описываются параметры применимые ко всем типам связей.
.. list-table:: Общие параметры связей
:widths: 60 80
:header-rows: 1
* - РўРёРї СЃРІСЏР·Рё
- Описание
* - Название связи
- | Обязательный параметр. Название связи. Также является меткой
| локализации: соответствует значению из колонки "Ref ID"
| в Редакторе локализации.
| Локализованное значение выводится в заголовке связи
| на форме (:numref:`7Pic52`).
* - Тип отображения
- | Обязательный параметр. Тип отображения связанных записей на форме.
| Cпособы отображения связи:
| «table» - в виде таблицы,
| «card» - в виде карточек (:numref:`7Pic53`).
* - Количество записей
- | Необязательный параметр. Количество отображаемых записей
| на странице (количество запрашиваемых строк для отображения).
| Если указан "0", то отображаются все связанные записи сразу.
* - Ключ связи
- | Обязательный параметр. Рдентификатор поля текущей формы,
| в котором хранится ключ для связи (идентификатор записи).
| Данный параметр используется всегда и во всех типах связей.
| В нем указывается идентификатор поля на форме, из которого
| следует брать значение для связи.
| Выбирается из списка полей
* - Условия выборки
- | Необязательный параметр. Дополнительное условие выборки
| из таблицы связей.
| Описывает выборку в формате Clause JSON.
* - Правила сортировки
- | Необязательный параметр. Правила сортировки связанных
| записей (результатов выборки связанных объектов).
| Указываются поля для, по которым сортируются записи в
| окне поиска через запятую.
| Знак минус перед именем поля указывает на то,
| что сортировка будет выполняться в обратном порядке.
..
.. _7Pic52:
.. figure:: Img/Connection_name.png
:scale: 80 %
:align: center
*Примеры заголовков связей на форме*
.. _7Pic53:
.. figure:: Img/View.png
:scale: 80 %
:align: center
*Примеры типов отображения связей на форме*
.. list-table:: Общие параметры, определяющие операции над связями
:widths: 60 80
:header-rows: 1
* - Тип операции
- Описание
* - Создаваемая
- | Обязательный параметр. Флаг. Показывает, возможно ли создание новой
| связанной записи из текущей формы
| (можно или создать новую запись и привязать к текущей).
| При установленном флаге в заголовке связи будет
| кнопка «Добавить» (:numref:`7Pic53`).
* - Связываемая
- | Обязательный параметр. Флаг. Показывает, возможно ли связать
| существующую запись с текущей формой
| (можно ли привязать существующую запись к текущей).
| При установленном флаге в заголовке связи будет
| кнопка «Связь» (:numref:`7Pic53`).
* - Удаляемая связь
- | Обязательный параметр. Флаг. Показывает, возможно ли удаление связи.
| При установленном флаге в последней колонке таблицы будет
| отображаться кнопка «Удалить связь» (:numref:`7Pic54`).
| При установленном флаге в карточке связи будет
| отображаться кнопка «Удалить связь» .
* - Удаляемая запись
- | Обязательный параметр. Флаг. Показывает, возможно ли удаление связанной записи вместе со связью.
| При установленном флаге в последней колонке таблицы будет
| отображаться кнопка «Удалить запись».
| При установленном флаге в карточке связи будет
| отображаться кнопка «Удалить запись» .
..
.. _7Pic54:
.. figure:: Img/Deletable_true_View_card.png
:scale: 80 %
:align: center
*Кнопка «Удалить» в таблице*
.. list-table:: Общие параметры, определяющие параметры отображения.
:widths: 60 80
:header-rows: 1
* - Тип операции
- Описание
* - РРєРѕРЅРєР°
- | Необязательный параметр. РРјСЏ РёРєРѕРЅРєРё, которая будет отображаться
| рядом с записью для визуального определения связанной сущности.
| Выбирается из списка доступных иконок.
* - Поля для отображения
- | Обязательный параметр. Список идентификаторов полей,
| которые будут выбраны из связанной схемы и будут
| отображаться в таблице/карточке.
| Поля выбираются из списка. Для каждого поля может
| быть задано значение по умолчанию (:numref:`7Pic54_2`) .
..
.. _7Pic54_2:
.. figure:: Img/FormEditorLinkViewFields.png
:scale: 80 %
:align: center
*Кнопка «Удалить» в таблице*
--------------------------------------------------------
Настройка прямой простой связи
--------------------------------------------------------
.. list-table:: Параметры, определяющие настройки прямой простой связи
:widths: 60 80
:header-rows: 1
* - Название параметра
- Описание
* - Связанная форма
- | Необязательный параметр. Рдентификатор формы,
| которая открывается при клике на связь.
| Если параметр не указана, то форму открывать не нужно.
* - Схема связанных записей
- | Обязательный параметр. Рдентификатор схемы,
| в которой хранятся связанные записи.
* - Связанное поле схемы
- | Обязательный параметр. Рдентификатор поля РІ связанной
| схеме "schema_id", значение которого должно соответствовать
| ключу связи в текущей форме.
.. list-table:: Параметры, определяющие правила создания связанных записей
:widths: 60 80
:header-rows: 1
* - Название параметра
- Описание
* - | Форма для создания
| связанной сущности
- | Обязательный параметр. Рдентификатор формы, РІ которой
| нужно создать связанную сущность.
* - | Выбрать данные для
| связанной сущности
- | Набор параметров:
| поле формы для создания,
| источник значения,
| значение.
| Рспользуемые для предварительного заполнения значений
| создаваемой формы для обеспечения связи (:numref:`7Pic54_3`).
.
.. _7Pic54_3:
.. figure:: Img/FormEditorLinkCreate.png
:scale: 80 %
:align: center
Настройка данных для создания связанных сущностей.
.. list-table:: Параметры, определяющие правила поиска записей
:widths: 60 80
:header-rows: 1
* - Название параметра
- Описание
* - Условия выборки
- | Дополнительные условия фильтрации для отображения
| записей в окне поиска.
* - Правила сортировки
- | Перечень полей по которым сортируются записи в окне поиска.
* - Количество записей
- | Количество записей, выводимых на одну страницу окна поиска.
* - Поля для поиска (:numref:`7Pic55`)
- | Перечень полей схемы, в которой хранятся связанные записи,
| по которым производится поиск значения,
| введенного в поле "Найти" в окне поиска.
.
.. _7Pic55:
.. figure:: Img/Search_connect.png
:scale: 80 %
:align: center
*Окно поиска существующих записей для создания связи с ними*
--------------------------------------------------------
Настройка табличной простой связи
--------------------------------------------------------
.. list-table:: Параметры, определяющие настройки связанной схемы
:widths: 60 80
:header-rows: 1
* - Название параметра
- Описание
* - Связанная форма
- | Необязательный параметр. Рдентификатор формы,
| которая открывается при клике на связь.
| Если параметр не указана, то форму открывать не нужно.
* - Схема связанных записей
- | Обязательный параметр. Рдентификатор схемы,
| в которой хранятся связанные записи.
* - Связанное поле схемы
- | Обязательный параметр. Рдентификатор поля РІ связанной
| схеме "schema_id", значение которого должно соответствовать
| ключу связи в текущей форме.
.. list-table:: Параметры, определяющие настройки схемы связей
:widths: 60 80
:header-rows: 1
* - Название параметра
- Описание
* - Таблица связей
- | Обязательный параметр.
| Рдентификатор таблицы связей.
* - Поле родительской записи
- | Обязательный параметр. Рдентификатор поля,
| в котором хранится ключ родительской записи.
* - Поле дочерней записи
- | Обязательный параметр. Рдентификатор поля,
| в котором хранится ключ связанной записи.
* - Поле группировки результатов
- | Необязательный параметр. Рдентификатор поля
| таблицы связей для группировки результатов.
| таблицы связей для группировки результатов.
| поле по которому будут группироваться записи
| связанной схемы на форме.
Правила отображения, создания связанных записей и поиска аналогичны соответствующим параметрам прямой простой связи.
--------------------------------------------------------
Настройка табличной сложной связи
--------------------------------------------------------
Табличная сложная связь позволяет описать связь между разными схемами через промежуточную таблицу.
Связанная схема определяется по специальному атрибуту таблицы связей.
| Рто поле **"Поле типа связанной сущности"** находится РЅР° вкладке **Сложная** редактора СЃРІСЏР·Рё.
| Данное поле должно быть перечисляемым полем (**ENUM**).
| Для каждого возможного значения параметра описываются свои параметры выборки: схема, поля, условия и т.п.
| в редакторе **правил работы со связанными сущностями** на той же вкладке,
| т.к. они могут иметь разную структуру и поэтому для их отображения на форме должны использоваться разные таблицы или карточки.
Параметры, определяющие настройки каждой связанной схемы аналогичны параметрам прямой простой связи.
--------------------------------------------------------
Сохранение изменений
--------------------------------------------------------
Конфигурация связей сохраняется как часть общей конфигурации формы при нажатии на кнопку **Сохранить форму**.
--------------------------------------------------------
Удаление связи
--------------------------------------------------------
Удаление конфигурации связи осуществляется при нажатии на иконку **Удалить связь** .
--------------------------------------------------------
Просмотр описания конфигурации в виде json
--------------------------------------------------------
Просмотр конфигурации связи в виде json осуществляется по нажатию на иконку **json** |fleJson_ic| заголовка редактора отдельной связи.
Пример описания полной конфигурации в json описан в приложении(см. :ref:`Приложение 2. Пример конфигурации связей формы с другими формами`).
**************************************************************
Общий функционал редактора компонента формы
**************************************************************
==================================================
Создание компонента формы
==================================================
Компонент формы создается путем перетаскивания компоненты или схемы поля из левой части редактора компонентов в рабочую область визуального редактора форм на закладке **Компоненты** редактора.
.. _pic-admin-formeditor-add-component:
.. figure:: Img/formeditor-add-component.png
:scale: 80 %
:align: center
*Создание компонента*
==================================================
Добавление недостающих полей
==================================================
| Над перечнем полей схемы доступна групповая операция: **Добавить недостающие поля**
| При перетаскивании компонента в рабочую область (в существующую группу или новую) на форму будут добавлены все недостающие поля.
==================================================
Контекстные операции редактора компонента формы
==================================================
По вызове контекстного меню компонента формы, пользователю доступны следующие операции:
* **Редактировать** - открывается редактор компонента формы
* **Клонировать** - клонируется компонент формы. (Размещается рядом с текущим компонентом)
* **Удалить** - удаление компонента из формы
* **Переключить видимость** - позволяет сделать поле невидимым для пользователя
* **Расширить/сжать** - позволяет полю занимать всю строку на форме или делить строку с другими компонентами.
==================================================
Сохранение изменений компонента формы
==================================================
| Сохранение изменений в компоненте форм доступно при нажатии на кнопку **Сохранить** в открытом редакторе компонента формы.
| При сохранении окно редактора компонента закрывается.
==================================================
Отмена изменений компонента формы
==================================================
| Отмена изменений в компоненте форм доступно при нажатии на кнопку **Отмена** в открытом редакторе компонента формы.
| При отмене окно редактора компонента закрывается.
==================================================
Закрытие редактора компонента формы
==================================================
Закрытие редактора компонента формы доступно при нажатии на кнопку **X** в открытом редакторе компонента формы (в правом верхнем углу редактора).
==================================================
Рзменение положения компонента РЅР° форме
==================================================
Рзменение положения компонента РЅР° форме осуществляется РІ режиме **Drag&Drop**. Для этого СЃ помощью мышки надо захватить компонент (слева РѕС‚ компонента РІРёРґРЅР° область захвата) Рё перетащить компонент РІ нужное место РЅР° форме.
.. _Настройка компонентов шаблона:
**************************************************************
Описание операций на вкладках редактора компонента формы
**************************************************************
После перетаскивания компонента в рабочую область создания шаблона автоматически открывается форма создания/редактирования компонента шаблона, имеющая следующие вкладки (:numref:`7Pic27`):
* Свойства.
* Стиль.
* Локаль.
* Данные.
.. _7Pic27:
.. figure:: Img/rsozd.png
:scale: 80 %
:align: center
*Форма создания компонента шаблона, вкладка "Свойства"*
==================================================
Вкладка «Свойства»
==================================================
На вкладке «Свойства» расположены следующие поля (:numref:`7Pic27`) и (:numref:`7Pic28`):
.. _7Pic28:
.. figure:: Img/rsozdn.png
:scale: 80 %
:align: center
*Поля вкладки «Свойства»*
==================================================
Вкладка «Параметры»
==================================================
Пример заполнения поля «Параметры»: ::
"dependencies":[
{
"name":"mapIncidentsHandler",
"url":"/forms/incidents/MapIncidentHandler.js"
},
{
"name":"some_other_dependency",
"url":"/dbg/logger.js"
}
]
Здесь указано следующее:
*dependencies*
В квадратных скобках перечисляются все зависимости. Каждая зависимость указывается в фигурных скобках.
*name*
Указывается наименование зависимости. В примере указаны две зависимости, их наименования: "mapIncidentsHandler" и "some_other_dependency".
*url*
Указывается путь к внешнему js-файлу, содержащему скрипт. Компоненту на вход подается скомпилированный объект из этого скрипта.
**Дополнительные свойства в поле «Параметры»**
В поле «Параметры» также можно указать ряд дополнительных свойств компонента:
*Свойство «collapsed»*
Свойство задает состояние свернутости для групп компонентов формы. Может принимать значения «true»/«false».
Пример свойства «collapsed»: ::
{"collapsed":true}
*Свойство «pallete»*
В этом свойстве указывается имя палитры, из которой будут извлекаться настройки стиля для компонента.
Свойство применяется к компонентам шаблона с типом данных «enum». Подробнее о типах см. `Описание типов компонентов`_.
Пример свойства «pallete»: ::
{"pallete":"priority_1"}
Здесь указано имя палитры «priority_1».
По имени палитры из настроек приложения (preferences) извлекается JSON с настройками палитры.
Пример палитры «priority_1» в формате JSON: ::
{
"0": {
"icon": {
"name": "priority_0"
},
"style": {
"color": "#9B0000"
},
"class": "pallete__priority_1_01"
},
"1": {
"icon": {
"name": "priority_1"
},
"style": {
"color": "#FF5F00"
},
"class": "pallete__priority_1_02"
},
"2": {
"icon": {
"name": "priority_2"
},
"style": {
"color": "#FFD300"
},
"class": "pallete__priority_1_03"
},
"3": {
"icon": {
"name": "priority_3"
},
"style": {
"color": "#588F00"
},
"class": "pallete__priority_1_04"
}
}
*Свойство «matrix»*
Указывается матрица преобразования: массив соответствий между наборами значений наблюдаемых компонентов формы и значением данного компонента формы.
Данный компонент формы приобретает такое значение, которое соответствует набору значений наблюдаемых компонентов формы в матрице преобразования.
Если у наблюдаемых компонентов формы меняются значения, то в данном компоненте формы значение также поменяется на то, которое
соответствует новому набору значений наблюдаемых компонентов формы в матрице преобразования.
Матрица преобразования указывается в поле «Параметры». Перечень наблюдаемых компонентов формы указывается в поле «Calculated» вкладки «Свойства» данного компонента формы.
Пример свойства «matrix»: ::
// структура в поле «Параметры»
{
"matrix": {
"out_val_1": [0,1],
"out_val_2": [1,0]
}
}
// структура в поле «Calculated»
{
"useMatrix": true,
"fields": [
"2578abc6-6f29-3d4c-a3ab-971cf05c4923",
"d13bfbac-ddab-3ec3-8ab1-588ff539e974"
],
"template": "{{ mx(fields,matrix,'OUT_DEFAULT_VALUE') }}"
}
Здесь указано следующее:
*matrix (в поле «Параметры»)*
В фигурных скобках формируется матрица, определяющая соответствие возможных значений данного компонента формы и набора значений наблюдаемых
компонентов формы. В приведенном примере данный компонент формы может принимать одно из значений: "out_val_1" или "out_val_2" в зависимости
от набора значений компонентов формы, указанных в параметре «fields» (в поле «Вычисляемое»).
Если набор значений компонентов формы, указанных в параметре «fields», будет [0,1], то значение данного компонента будет "out_val_1".
Если набор значений компонентов формы, указанных в параметре «fields», будет [1,0], то значение данного компонента будет "out_val_2".
Если набор значений компонентов формы, указанных в параметре «fields», будет отличный от указанных в массиве «matrix», то
у данного компонента формы будет значение по умолчанию, указанное в темплейте («template» в поле «Вычисляемое») в параметре «defaults».
В примере это значение «OUT_DEFAULT_VALUE».
.. note:: Порядок полей в массивах в «matrix» должен соответствовать порядку полей в «fields».
*useMatrix (в поле «Вычисляемое»)*
Флаг, необходимый для различия между простым темплейтом и матричным преобразованием. В данном случае флаг должен принимать значение «true».
*fields (в поле «Вычисляемое»)*
В квадратных скобках указываются идентификаторы наблюдаемых компонентов формы.
В примере это значения «2578abc6-6f29-3d4c-a3ab-971cf05c4923» и «d13bfbac-ddab-3ec3-8ab1-588ff539e974».
*template (в поле «Вычисляемое»)*
В темплейте указывается функция, с помощью которой будет определяться значение в данном компоненте формы.
В примере это функция «mx» с параметрами «fields» (список значений полей), «matrix» (матрица соответствия значений полей),
«OUT_DEFAULT_VALUE» (значение по умолчанию, если соответствия в матрице не найдено).
*Вычисляемое*
В данном поле можно задать вычисляемое значение. Значение в этом поле вычисляется на основе значений других полей.
Условие, по которому вычисляется значение, указывается в формате JSON.
Пример заполнения поля «Вычисляемое»: ::
{
// список полей наблюдения
"fields":['field-id-1','field-id-2'],
// темплейт для преобразования значения поля
"template":"{{ ['field-id-1','field-id-2'].join(';') }}",
// значение по-умолчанию, используемое в случае ошибок вычисления
"default":"DEFAULT_FIELD_VALUE"
}
Здесь указано следующее:
*fields*
Перечисляется массив идентификаторов полей формы, по которым производится наблюдение.
*template*
Указывается темплейт (шаблон) в формате плагина «SelectTransform», по которому будет преобразовано
значение поля «Calculated» при изменении полей из массива «fields». Допустимо применять методы и свойства из библиотеки «mathjs».
*default*
Указывается значение поля, которое будет присвоено при ошибках вычисления, отсутствии значения у полей из массива «fields» и т.п.
*Действия*
В этом поле можно указать действие в формате JSON, которое будет выполнятся при определенных условиях. Формат записи может отличаться в зависимости от разных действий.
JSON-строка в поле «Действия» в общем виде выглядит так: ::
{"название_действия": { /* параметры */ } }
Пример действия «onLoad» для подгрузки значений в поле: ::
{"onLoad":{"form_field":"in_009_015","schema":"people","field":"full_name"}}
Здесь указано следующее:
*onLoad*
Указывается название действия. В примере это "onLoad".
*form_field*
Указывается идентификатор поля на форме, куда нужно подгружать данные. В примере это "in_009_015".
*schema*
Указывается идентификатор схемы, из которой выводятся данные на форму. В примере это "people".
*field*
Указывается идентификатор поля схемы, из которого выводятся данные на эемент формы. В примере это "full_name".
*Видимый на*
В поле можно указать условие видимости для элемента. Условие применяется, только при включенном переключателе «Видимый» на вкладке «Свойства»
компонента (:numref:`7Pic28`). Условие указывается в формате JSON.
Пример заполнения поля «Видимый на»: ::
{
// ID другого элемента формы, значение которого нужно проверить
id: 'field123',
// значение
value: '123'
}
Здесь указано следующее:
данный компонент будет отображаться на форме, только если у другого компонента формы, имеющего идентификатор "field123", значение будет равным "123".
То есть данный компонент будет виден или скрыт в зависимости от значения в другом компоненте формы.
==================================================
Вкладка «Стиль»
==================================================
На вкладке «Стиль» сейчас используются следующие элементы (:numref:`7Pic32`):
.. _7Pic32:
.. figure:: Img/Style.png
:scale: 80 %
:align: center
*Вкладка «Стиль»*
*Строчный*
Рлемент интерфейса «Переключатель». Если переключатель «Строчный» включен, то РЅР° форме РїРѕРґРїРёСЃСЊ компонента будет располагаться РЅР° РѕРґРЅРѕРј СѓСЂРѕРІРЅРµ СЃ полем.
Если переключатель «Строчный» выключен, то на форме подпись компонента будет располагаться над полем.
*РЁРёСЂРѕРєРёР№*
Рлемент интерфейса «Переключатель». Если переключатель «Широкий» включен, то РЅР° форме компонент будет растянут РЅР° РІСЃСЋ строку.
Если переключатель «Широкий» выключен, то на форме компонент займет половину строки (т.е. в строке будет расположено два компонента по горизонтали).
*Класс*
В данном поле можно прописать любые классы, поддерживаемые quasar (например q-pa-md, text-green, 'bg-red-4' и т.п.).
Также в поле "Класс" для компонента с типом «button» можно указать значение, в зависимости от которого у кнопки на форме будут разные цвета.
==================================================
Вкладка «Локаль»
==================================================
На вкладке «Локаль» задаются локализованные значения для лейбла, плейсхолдера и подсказки компонента (:numref:`7Pic31`).
.. _7Pic31:
.. figure:: Img/Local.png
:scale: 80 %
:align: center
*Вкладка «Локаль»*
После нажатия на кнопку |Local_ic1| «Править локализацию» происходит переход в Редактор локализации, в котором указываются необходимые значения для лейбла, плейсхолдера и подсказки компонента.
Подробнее см. :ref:`Руководство по настройке локализации`.
==================================================
Вкладка «Данные»
==================================================
На вкладке «Данные» при необходимости указываются данные для компонента в формате JSON. Например, для компонента с типом «table»
на вкладке «Данные» перечисляются колонки таблицы (:numref:`7Pic45`).
**Описание параметра showDefaultsOnOpen компонента формы.**
Параметр необходим для отображения значения поля по умолчанию в режиме создания записи.
В параметрах компонента формы прописываются настройки, среди которых указывается свойство showDefaultsOnOpen со значением true или false.
Если это свойство в настройках не описано, то считается, что оно равно false.
Когда форма открывается для создания, то компоненты, у которых showDefaultsOnOpen равно true,
будут заполнены значением из поля настроек "По умолчанию".
Если showDefaultsOnOpen равно false (либо не заполнено), то значение такого компонента будет - пустая строка.
**********************************************
Приложения
**********************************************
==================================================
Описание параметров json связи
==================================================
На вкладе «Связи» в формате JSON указывается конфигурация связей данной формы с другими формами.
Конфигурация связей данной формы с другими формами представляет собой массив, состоящий из конфигураций отдельных связей.
.. note:: Пример конфигурации связей формы с другими формами с пояснениями см. в приложении :ref:`Приложение 2. Пример конфигурации связей формы с другими формами`.
Параметры конфигурации связей могут быть следующими:
* Общие.
* Параметры связи через таблицу ("relation_type: table").
* Параметры для простых связей ("relation_subtype: simple").
* Параметры для сложных связей ("relation_subtype: complex").
**Общие параметры**
*name*
Обязательный параметр. Название связи. Также является меткой локализации: соответствует значению из колонки "Ref ID" в Редакторе локализации.
*view*
Обязательный параметр. Тип отображения связанных записей на форме (способ отображения связи): «table» - в виде таблицы, «card» - в виде карточек (:numref:`7Pic53`).
*page_size*
Необязательный параметр. Количество отображаемых записей на странице (количество запрашиваемых строк для отображения). Если указан "0", то отображаются все связанные записи сразу.
*relation_type*
Обязательный параметр. Тип связи. Значения: «direct» - прямая связь по ключу, «table» - связь через таблицу связей.
*relation_subtype*
Обязательный параметр. Подтип связи. Значения: «simple» - связь только с одним типом сущностей, «complex» - связь с несколькими типами сущностей.
*form_field_id*
Обязательный параметр. Рдентификатор поля текущей формы, РІ котором хранится ключ для СЃРІСЏР·Рё (идентификатор записи).
Данный параметр используется всегда и во всех типах связей. В нем указывается идентификатор поля на форме, из которого следует брать значение для связи.
*sort*
Необязательный параметр. Правила сортировки связанных записей (результатов выборки связанных объектов).
**Параметры связи через таблицу ("relation_type: table")**
В конфигурациях с "relation_type: table" связь осуществляется через таблицу, указанную в параметре "rel_schema_id".
Параметр "rel_schema_key" в таблице связи указывает на "field_id формы". По этой связке "field_id" - "rel_schema_key" из таблицы связи "rel_schema_id"
извлекаются записи, в которых значения поля "rel_schema_field_id" указывают уже на записи в конечной схеме.
Таблица связи есть в любой табличной связи. Разница между "простой" и "сложной" в том, что "простая" связь в конечном итоге получает записи из одной схемы,
а "сложная" - из нескольких схем.
*rel_schema_id*
Обязательный параметр. Рдентификатор таблицы связей.
*rel_schema_key*
Обязательный параметр. Рдентификатор поля РІ таблице связей, РІ котором указан идентификатор родительской записи.
*rel_schema_field_id*
Обязательный параметр. Рдентификатор поля РІ таблице связей, РІ котором указан идентификатор дочерней записи.
*rel_clause*
Необязательный параметр. Дополнительное условие выборки из таблицы связей.
*group_field_id*
Необязательный параметр. Рдентификатор поля таблицы связей для РіСЂСѓРїРїРёСЂРѕРІРєРё результатов.
**Параметры для простых связей ("relation_subtype: simple")**
*creatable*
Обязательный параметр. Показывает, возможно ли создание новой связанной записи из текущей формы (можно ли создать новую запись и привязать к текущей).
Значения: «true»/«false». При «creatable: true» в заголовке связи будет кнопка «Добавить» (:numref:`7Pic53`).
*relatable*
Обязательный параметр. Показывает, возможно ли связать существующую запись с текущей формой (можно ли привязать существующую запись к текущей).
Значения: «true»/«false». При «relatable: true» в заголовке связи будет кнопка «Связь» (:numref:`7Pic53`).
*deletable*
Обязательный параметр. Показывает, возможно ли удаление связи.
Значения: «true»/«false». При «deletable: true» и "view": "table" в последней колонке таблицы будет отображаться кнопка «Удалить связь».
При «deletable: true» и "view": "card" в карточке связи будет отображаться кнопка «Удалить связь» .
*schema_id*
Обязательный параметр. Рдентификатор схемы, РІ которой хранятся связанные записи.
*schema_field_id*
Обязательный параметр. Рдентификатор поля РІ связанной схеме "schema_id", значение которого должно соответствовать ключу СЃРІСЏР·Рё РІ текущей форме.
* Если связь прямая ("relation_type": "direct"), то значение из параметра "form_field_id" связывается с полем
"schema_field_id" в конечной схеме "schema_id".
* Если связь табличная-простая ("relation_type": "table", "relation_subtype": "simple"), то для связи используется таблица связи.
В этом случае нужно искать значение из "form_field_id" в таблице связи. После этого в найденных записях смотрятся значения в поле,
указанное РІ параметре "rel_schema_field_id". Рти значения РјРѕРіСѓС‚ быть разными Рё нужно искать каждое РёР· РЅРёС… РІ схеме СЃ идентификатором,
указанным в параметре "schema_id", в поле этой схемы "schema_field_id". Так как конечная схема одна, то все записи имеют одну структуру и
отображаются в одной таблице или в одном наборе карточек.
* В сложной табличной связи ("relation_type": "table", "relation_subtype": "complex") добавляются разные схемы (разные сущности).
Поэтому параметры "schema_id" (в какой схеме искать) и "schema_field_id" (по какому полю искать) описываются не в корне описания связи,
а для каждой сущности отдельно в блоке "relations".
*clause*
Необязательный параметр. Дополнительное условие выборки связанных объектов.
*icon*
Необязательный параметр. РРјСЏ РёРєРѕРЅРєРё, которая будет отображаться СЂСЏРґРѕРј СЃ записью для визуального определения связанной сущности.
*related_form_id*
Необязательный параметр. Рдентификатор формы, которую нужно открыть РїСЂРё клике РЅР° запись. Если параметр РЅРµ указана, то форму открывать РЅРµ нужно.
*fields*
Обязательный параметр. Список идентификаторов полей, которые будут выбраны из связанной схемы и будут отображаться в таблице/карточке.
Пример структуры параметра «fields»: ::
"fields": [
{
"id": "schm054_240001005",
"default": "N/A"
},
...
]
Здесь указано следующее:
*id*
Обязательный параметр. Рдентификатор поля РІ схеме связанной записи.
*default*
Отображаемое значение в случае, если поле не заполнено.
*create*
Обязателен для "creatable: true". Описание процесса (конфигурация), правила создания новой связанной записи.
Пример структуры параметра "create": ::
"create": {
"form": "form_5601",
"data": {
"form_5601_143_001_12": {
"source": "parent_field",
"value": "in_001_003"
},
"form_5601_122_001_29": {
"source": "json",
"value": "HPD:Help Desk"
}
},
"relation_data": {}
}
Здесь указано следующее:
*form*
Обязательный параметр. Рдентификатор формы, РІ которой нужно создать связанную сущность.
*data*
Данные для создания связанной сущности. Все данные, указанные в параметре "data", записываются в конечную схему со связанными записями.
Здесь "source" - это источник для заполнения поля. Если "source": "parent_field", то значение берется из основной формы
(из которой создается связанная запись). В "value" при этом хранится идентификатор поля в основной форме, из которого нужно взять значение. Если "source": "json", то
значение в поле связываемой формы подставляется в "чистом" виде, прямо из "value".
*relation_data*
Данные для создания записи в таблице связей. Все данные, указанные в параметре "relation_data", записываются в таблицу связи.
Здесь указаны поля в схеме связи, в которые нужно что-то записать, источник ("source") и значение ("value").
Значения параметра "source": "json" - записывается значение из свойства "value" конфигурации,
"child_field" - значение из конечной схемы, из поля, идентификатор которого указан в "value".
Для записи значений, указанных в структуре "relation_data", при создании новой записи сначала нужно открыть пустую форму с идентификатором, указанным в параметре "form".
Затем указать необходимые данные и сохранить. Значения, указанные в структуре "relation_data", вносятся в таблицу связи.
Значения из структуры "relation_data", у которых "source": "child_field" берутся из вновь созданной записи.
*relate*
Обязателен для "relatable: true". Описание процесса (конфигурация) создания связи с существующей записью.
В блоке "data" указывается, какие значения в какие поля таблицы связи нужно записать при создании связи с существующей записью.
*search*
Обязателен для "relatable: true". Описание процесса (конфигурация) поиска существующих записей для создания связи с ними.
Конфигурация "search" содержит следующие блоки:
* clause - дополнительные условия фильтрации для отображения записей в окне поиска.
* sort - указываются поля для, по которым сортируются записи в окне поиска.
* page_size - количество записей, выводимых на одну страницу окна поиска.
* search_fields - перечень полей схемы, в которой хранятся связанные записи, по которым производится поиск значения, введенного в поле "Найти"
РІ РѕРєРЅРµ РїРѕРёСЃРєР°.
**Параметры для сложных связей ("relation_subtype: complex")**
Для сложной табличной связи ("relation_type": "table", "relation_subtype": "complex"), как и для простой табличной связи
("relation_type": "table", "relation_subtype": "simple"), используется таблица связи. Но кроме простого связывания значения на форме с значениями
в схеме, в этой таблице связи используется параметр "entity_type_field_id" для указания того, какие сущности будут привязываться.
В параметре "entity_type_field_id" содержатся значения (сущности), которые нужно выбрать и отобразить отдельно.
РС… следует отображать отдельно, С‚.Рє. РѕРЅРё РјРѕРіСѓС‚ иметь разную структуру Рё поэтому для РёС… отображения РЅР° форме должны использоваться разные таблицы или карточки.
Для каждой сущности из параметра "entity_type_field_id" описываются свои параметры выборки: схема, поля, условия и т.п.
Рто можно увидеть РІ блоке "relations" РІ конфигурации связей РЅР° примере ключа 6000 (СЃРј. :ref:`Приложение 2. Пример конфигурации связей формы СЃ РґСЂСѓРіРёРјРё формами`).
Алгоритм следующий:
* Необходимо взять значение, указанное в поле формы, идентификатор которого является значением параметра "form_field_id".
* Затем в таблице связей необходимо найти все записи, у которых значение параметра "rel_schema_key" равно значению поля формы, которое было найдено
в предыдущем пункте.
* Затем необходимо у всех записей, выбранных в предыдущем пункте, посмотреть значения, указанные в параметре "entity_type_field_id".
* В зависимости от того, какое значение указано в параметре "entity_type_field_id" (6000, 9000, 12000, 16000, 20000, 33000 см. :ref:`Приложение 2. Пример конфигурации связей формы с другими формами`),
необходимо применить соответствующие параметры запроса к схемам данных.
*entity_type_field_id*
Обязательный параметр. Рдентификатор поля, РїРѕ которому определяется тип связанной сущности.
*relations*
Обязательный параметр. Представляет собой описание работы со связанными сущностями. В блоке "relations" Для каждой сущности из параметра
"entity_type_field_id" описываются свои параметры выборки: схема, поля, условия и т.п.
Ртот параметр является JSON-объектом, Сѓ которого: ключи - это значения поля, указанного РІ параметре В«entity_type_field_idВ»; значения - это объекты СЃ описанием простой СЃРІСЏР·Рё.